Add LICENSE, issue templates, CONTRIBUTING.md, and Related Projects to README#30
Open
Add LICENSE, issue templates, CONTRIBUTING.md, and Related Projects to README#30
Conversation
❌ Deploy Preview for shadowgraph-airdrop failed. Why did it fail? →
|
…G.md Co-authored-by: Steake <530040+Steake@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add MIT License and improve README with related projects
Add LICENSE, issue templates, CONTRIBUTING.md, and Related Projects to README
Feb 22, 2026
Steake
approved these changes
Feb 22, 2026
There was a problem hiding this comment.
Pull request overview
This PR adds essential community infrastructure and discoverability improvements to the Shadowgraph Reputation-Gated-Airdrop repository. It introduces an MIT license, contribution guidelines, GitHub issue templates, and a Related Projects section to help external users discover related work and contribute to the project.
Changes:
- Adds MIT License with Oliver C. Hirst as copyright holder (2025-2026)
- Creates CONTRIBUTING.md with project overview, contribution areas, and PR workflow guidelines
- Adds three GitHub issue templates for bug reports, feature requests, and good first issues
- Appends a Related Projects section to README.md linking to EQBSL, BitCell, shannon-uncontained, and Clario
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| LICENSE | Standard MIT License with copyright 2025-2026 Oliver C. Hirst |
| README.md | Adds Related Projects section with links to four related repositories and tech stack notes |
| CONTRIBUTING.md | Contribution guide covering project description, contribution areas, workflow, and PR guidelines |
| .github/ISSUE_TEMPLATE/bug_report.md | Bug report template with description, repro steps, expected/actual behavior, and environment fields |
| .github/ISSUE_TEMPLATE/feature_request.md | Feature request template with description, motivation, proposed solution, and alternatives |
| .github/ISSUE_TEMPLATE/good-first-issue.md | Good first issue template with description, acceptance criteria, helpful links, and contributor notes |
Comments suppressed due to low confidence (3)
CONTRIBUTING.md:26
- The commands in this section use
npmbut the codebase consistently usesyarnthroughout. The README.md usesyarncommands (lines 127-133), the CI workflow (.github/workflows/zkml-pipeline.yml) usesyarn, and package.json scripts referenceyarn. To maintain consistency, these commands should useyarninstead ofnpm.
npm run format && npm run lint
- Run the tests to confirm nothing is broken:
npm run test:unit
**README.md:140**
* These links use HTML anchor tag syntax, but the rest of the README uses standard Markdown link syntax. For consistency with the existing README conventions (see lines 27-29, 33-34), these should use Markdown format: `[EQBSL](https://github.com/Steake/EQBSL)` instead of `<a href="https://github.com/Steake/EQBSL">EQBSL</a>`.
- EQBSL — The trust-as-ledgered-state framework powering the reputation scoring. TypeScript/Angular.
- BitCell — Consensus through cellular automaton warfare using EBSL trust scores. Rust.
- shannon-uncontained — Agentic pen-testing fork with EQBSL epistemic bookkeeping. JavaScript.
- Clario — Crypto-native tutoring marketplace powered by EQBSL reputation. TypeScript/React.
**.github/ISSUE_TEMPLATE/good-first-issue.md:18**
* The acceptance criteria reference `npm run` commands, but the codebase uses `yarn` as its package manager. These should be `yarn test:unit` and `yarn format && yarn lint` to match the conventions in README.md and the CI workflow.
- Relevant tests pass (
npm run test:unit) - Code is formatted and linted (
npm run format && npm run lint)
</details>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Bundles community and discoverability scaffolding missing from the repo.
Changes
LICENSEMIT License, copyright Oliver C. Hirst 2025-2026.
README.mdAppended
## Related Projectssection linking EQBSL, BitCell, shannon-uncontained, and Clario with brief tech-stack annotations..github/ISSUE_TEMPLATE/Three templates added:
bug_report.md— description, repro steps, expected/actual behaviour, environmentfeature_request.md— description, motivation, proposed solution, alternativesgood-first-issue.md— scoped description, acceptance criteria checklist, helpful links; pre-labelledgood first issueCONTRIBUTING.mdCovers project context (ZKML/Sybil-resistant airdrops via EBSL), contribution areas (smart contracts, EZKL circuits, trust score models, Jupyter notebooks, frontend, docs), and the fork → branch → PR-against-
mainworkflow. Enforces one logical change per PR.Original prompt
This pull request was created from Copilot chat.
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.